Skip to content

Add options to encode stack information into an array#39

Merged
nhairs merged 12 commits intonhairs:mainfrom
1hakusai1:feature-stack-trace-as-array
Feb 4, 2025
Merged

Add options to encode stack information into an array#39
nhairs merged 12 commits intonhairs:mainfrom
1hakusai1:feature-stack-trace-as-array

Conversation

@1hakusai1
Copy link
Contributor

@1hakusai1 1hakusai1 commented Jan 5, 2025 •
edited
Loading

close #35

This PR add options to encode stack information into an array.

  • If exc_info_as_array is True (Defualt: False), formatter encode exc_info into an array.
  • If stack_info_as_array is True (Defualt: False), formatter encode stack_info into an array.

Checks

All tests are passed (including new test cases).

(python-json-logger) python-json-logger > black src tests
All done! ✨ 🍰 ✨
13 files left unchanged.
(python-json-logger) python-json-logger > pylint --output-format=colorized src

--------------------------------------------------------------------
Your code has been rated at 10.00/10 (previous run: 10.00/10, +0.00)

(python-json-logger) python-json-logger > mypy src tests
Success: no issues found in 13 source files
(python-json-logger) python-json-logger > pytest
=========================================================================== test session starts ===========================================================================
platform darwin -- Python 3.11.11, pytest-8.3.4, pluggy-1.5.0
rootdir: /Users/hakusai/src/python-json-logger
configfile: pyproject.toml
collected 181 items                                                                                                                                                       

tests/test_deprecation.py ......                                                                                                                                    [  3%]
tests/test_formatters.py ..............................................................................................................................x........... [ 79%]
x..x........x....................                                                                                                                                   [ 97%]
tests/test_missing.py ....                                                                                                                                          [100%]

===================================================================== 177 passed, 4 xfailed in 0.22s ======================================================================

nhairs
nhairs reviewed Jan 6, 2025
View reviewed changes
Copy link
Owner

@nhairs nhairs left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It feels like we should be overriding formatStack and formatException - thoughts?

Also don't forget to update the documentation.

@1hakusai1
Copy link
Contributor Author

1hakusai1 commented Jan 6, 2025

Should I update changelog.md and the version number in pyproject.toml?
I don't know whether to update now or upon release.

@nhairs
Copy link
Owner

nhairs commented Jan 10, 2025

I'll get back to this, got a busy few weeks so don't have time at the moment sorry

@nhairs nhairs force-pushed the feature-stack-trace-as-array branch from 40ccb83 to 7dfc5bb Compare February 1, 2025 04:57
nhairs
nhairs requested changes Feb 1, 2025
View reviewed changes
Copy link
Owner

@nhairs nhairs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your patience

  • I have a few nit-pick comments
  • Please do add to the change log, you can just make the version title UNRELEASED and I'll update it and the pyproject.toml when I package it.
  • Please consider updating the documentation

1hakusai1 and others added 8 commits February 2, 2025 22:51
@1hakusai1 @nhairs
Use isinstance for checking types
ddfbafe 
Co-authored-by: Nicholas Hairs <nicholashairs@gmail.com>
@1hakusai1 @nhairs
Use not in instead of dict.get
118a18b 
Co-authored-by: Nicholas Hairs <nicholashairs@gmail.com>
@1hakusai1 @nhairs
Use not in instead of dict.get
c475139 
Co-authored-by: Nicholas Hairs <nicholashairs@gmail.com>
@1hakusai1 @nhairs
Use isinstance for type checking
6d17759 
Co-authored-by: Nicholas Hairs <nicholashairs@gmail.com>
@1hakusai1
Ignore mypy rule "incompatible with return type in supertype"
ff8edd8
@1hakusai1
stack_info_str is already formatted
1d438d2
@1hakusai1
Update the change log
ae98635
@1hakusai1
Update the documentation for BaseJsonFormatter
94c37bf
@1hakusai1 1hakusai1 requested a review from nhairs February 2, 2025 14:35
nhairs
nhairs approved these changes Feb 3, 2025
View reviewed changes
Copy link
Owner

@nhairs nhairs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this, nice work.

I'll work on releasing this soon

@nhairs nhairs merged commit db04a0f into nhairs:main Feb 4, 2025
4 checks passed
@nhairs nhairs self-assigned this Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nhairs nhairs nhairs approved these changes

Assignees

@nhairs nhairs

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Feature Request: Encode stack traces as an array

2 participants

@1hakusai1 @nhairs